Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Doc mech #118

Open
wants to merge 22 commits into
base: main
Choose a base branch
from
Open

Doc mech #118

wants to merge 22 commits into from

Conversation

Sfgangloff
Copy link
Collaborator

No description provided.

@Sfgangloff Sfgangloff requested a review from mariapiamo March 11, 2025 19:06
Copy link

@Adamantios Adamantios left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment on lines -45 to +46
**2.** Setting up an EOA account:
**b.** Click on the account icon, then on “Add account or hardware wallet”, then “Add a new Ethereum account”, provide a name for the account and then click on “Add account”;

- *Option 1* (manual creation):
**c.** Select the newly created account and then click on the top-right menu icon and then “Account details”. You can find the private key by clicking “Show private key”.

**a.** Install browser extension of Metamask and open it;

**b.** Click on the account icon, then on “Add account or hardware wallet”, then “Add a new Ethereum account”, provide a name for the account and then click on “Add account”;

**c.** Select the newly created account and then click on the top-right menu icon and then “Account details”. You can find the private key by clicking “Show private key”.

**d.** Copy this key in the file `ethereum_private_key.txt` in your project folder (do not include any leading or trailing spaces, tabs or newlines or any other character);

- *Option 2* (using [open-autonomy](https://github.com/valory-xyz/open-autonomy)):

**a.** Use the following to generate a private key:
```
autonomy generate-key ethereum -n 1
```
This creates a file keys.json in which the private key can be found on the key “private_key”.
**b.** Copy this key in the file `ethereum_private_key.txt`.
**d.** Copy this key in the file `ethereum_private_key.txt` in your project folder (do not include any leading or trailing spaces, tabs or newlines or any other character);

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why was this changed?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Adamantios Only the part which creates the key file with autonomy generate-key ethereum -n 1 is removed (since it is not really needed ?)

Comment on lines +83 to +86
In order to find which tools the Mech uses, click on its service id, and then "View code" in the window which opens. Open the folder `mech` and then `service.yaml`. Copy the IPFS hash which follows `agent: valory/mech:0.1.0` and open the corresponding
file by going to https://gateway.autonolas.tech/ipfs/ with the copied hash at the end of this address. Open the `mech` folder and then the file `aea-config.yaml`. In this file, the keys of the dictionary `tools_to_package_hash` are the
names of the tools that this service uses.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not accurate. The aea config does not contain the tools that the mech is using, it is only a template with default values.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably the best option would be to point to the metadata and make sure that they are always updated.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Adamantios Do you suggest that we write a list of metadata hashes in this doc ? (because this is all off-chain)

```

Replace `<prompt>` by a string which corresponds to the request to send to the Mech, and `<chain-config>` by one of the keys in the dictionary found in the file `.mech_client/configs/mechs.json` (for instance "gnosis"). In the dictionary corresponding to this key, replace the value of `priority_mech_address` with the address of the mech you want to send the request to.
Change `<bool>` to True in order to use the off-chain method, and False otherwise.
Change `<bool>` to True in order to use the off-chain method, and False otherwise. Finally, change `<tool>` to the name of the tool you want to use.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should update this when we have a way for say which is the tool that a deployed mech has

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should still specify the tool, since otherwise it does not work (response is invalid).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants